/**
 * This file is part of 1genia trampoline
 * Copyright (C) 2007 1genia (contact@1genia.com)
 *
 * This library is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; version 3 of the License. 
 *
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details. 
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; see the file COPYING.TXT.  If not,
 * write to the Free Software Foundation, Inc., 51 Franklin Street,
 * Fifth Floor, Boston, MA 02110-1301, USA. 
 **/
package com.genia.toolbox.uml_generator.model;

/**
 * an interface representing an attribute.
 */
public interface AttributeModel
    extends AbstractObject
{

  /**
   * returns the type of the attribute.
   * 
   * @return the type of the attribute
   */
  public abstract AbstractJavaObject getType();



  /**
   * set the type of the attribute.
   * 
   * @param type
   *          the new type of the attribute
   */
  public abstract void setType(final AbstractJavaObject type);



  /**
   * returns the initial value of the attribute.
   * 
   * @return the initialValue
   */
  public abstract String getInitialValue();



  /**
   * returns wether this object must be mapped to the persistence API.
   * 
   * @return wether this object must be mapped to the persistence API
   */
  public abstract boolean isMappable();



  /**
   * set wether this object must be mapped to the persistence API.
   * 
   * @param isMappable
   *          wether this object must be mapped to the persistence API
   */
  public abstract void setMappable(boolean isMappable);



  /**
   * set the new initial value of the attribute.
   * 
   * @param initialValue
   *          the initialValue to set
   */
  public abstract void setInitialValue(final String initialValue);

}
